docs: add troubleshooting section#151
Merged
Merged
Conversation
Codecov Report
@@ Coverage Diff @@
## develop #151 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 24 24
Lines 705 705
Branches 68 68
=========================================
Hits 705 705 Continue to review full report at Codecov.
|
heitorlessa
reviewed
Aug 31, 2020
heitorlessa
suggested changes
Aug 31, 2020
Contributor
heitorlessa
left a comment
heitorlessa
left a comment
There was a problem hiding this comment.
Let me know if I misunderstood the guidance - I suspect it's missing a resolution besides naming the problem. I suspect you were also trying to run make docs-api-local
Contributor
|
Yes, unless you somehow (on purpose, pure evil) change directory and then
use poetry shell to run pdoc3 haha
…On Tue, 1 Sep 2020 at 13:02, Joris Conijn ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In CONTRIBUTING.md
<#151 (comment)>
:
> @@ -69,6 +69,9 @@ ***@***.*** with any additional questions or comments.
## Security issue notifications
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
+## Troubleshooting
+
+* The local **API reference** throws a `Module aws_lambda_powertools not found` error when an exception is raised in the code-base, when you run `poetry run pdoc --pdf aws_lambda_powertools` the exception is shown.
Ah nice I added the make dev as a solution as well, the pdoc3 path can't
be wrong anymore since we run everything in a poetry shell right?
—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
<#151 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAZPQBGXCBGUJQ4R433OH5LSDTIEFANCNFSM4QPX34CQ>
.
|
heitorlessa
approved these changes
Sep 1, 2020
Contributor
heitorlessa
left a comment
heitorlessa
left a comment
There was a problem hiding this comment.
Thanks a lot for adding the troubleshooting section - It'll help us provide more prescriptive guidance when hitting these pesky issues ;)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issue #, if available:
Description of changes:
Add a troubleshooting section in the CONTRIBUTING.md
Checklist
Update testsBreaking change checklist
RFC issue #:
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.